Reports > The report API > beginReporting()

 

beginReporting()

Description

Called at the start of the reporting process, before any reports are actually run. If the Report command returns false from this function, target is excluded from the report run.

Arguments

target

target is a string indicating the target of the report session. It can be one of the following values: "CurrentDoc", "CurrentSite", "CurrentSiteSelection" (for the selected files in a site), or "Folder:+ the path to the folder the user selected" (for example, "Folder:c:temp").

Returns

true if the report has run successfully, false if target is excluded from the report run.